Skip to content

feature: Add timeout to wait_for_endpoint and _wait_until. #2684

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
wants to merge 3 commits into from
Closed

feature: Add timeout to wait_for_endpoint and _wait_until. #2684

wants to merge 3 commits into from
+63 −17

Conversation

larroy
Copy link
Contributor

@larroy larroy commented Oct 4, 2021

This is useful for cases in which and endpoint takes unusually long to
come online.

Issue #, if available:

#2539

Description of changes:

Add timeout to wait_for_endpoint and _wait_until.

Testing done:

tox tests/unit

Merge Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your pull request.

General

  • I have read the CONTRIBUTING doc
  • I certify that the changes I am introducing will be backword compatible, and I have discussed concerns about this, if any, with the Python SDK team
  • I used the commit message format described in CONTRIBUTING
  • I have passed the region in to all S3 and STS clients that I've initialized as part of this change.
  • I have updated any necessary documentation, including READMEs and API docs (if appropriate)

Tests

  • I have added tests that prove my fix is effective or that my feature works (if appropriate)
  • I have added unit and/or integration tests as appropriate to ensure backward compatibility of the changes
  • I have checked that my tests are not configured for a specific region or account (if appropriate)
  • I have used unique_name_from_base to create resource names in integ tests (if appropriate)

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@shreyapandit shreyapandit changed the title change: Add timeout to wait_for_endpoint and _wait_until. feature: Add timeout to wait_for_endpoint and _wait_until. Oct 4, 2021
shreyapandit
shreyapandit suggested changes Oct 4, 2021
View reviewed changes
src/sagemaker/session.py
"""
desc = _wait_until(lambda: _deploy_done(self.sagemaker_client, endpoint), poll)
desc = _wait_until(
lambda: _deploy_done(self.sagemaker_client, endpoint), poll, timeout_seconds
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we also take this opportunity to rename deploy_done to deploy_status or something similar to keep it in same lines of naming as the other status check methods? Thanks!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good suggesiton, but I think we should do that in another CR to keep this in scope. Also, why there's so many print functions instead of logging? printing from a library isn't generally a good practice.

mufaddal-rohawala
mufaddal-rohawala reviewed Oct 4, 2021
View reviewed changes
tests/unit/test_exception_on_bad_status.py
return DEFAULT

if block_seconds:
side_effect = side_effect_fn
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: not needed, can add it on line 42.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what do you mean? Can you propose alternative code instead?

@sagemaker-bot
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: sagemaker-python-sdk-unit-tests
  • Commit ID: 03dc13c
  • Result: FAILED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@sagemaker-bot
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: sagemaker-python-sdk-unit-tests
  • Commit ID: d5c3779
  • Result: FAILED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@sagemaker-bot
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: sagemaker-python-sdk-slow-tests
  • Commit ID: d5c3779
  • Result: FAILED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@sagemaker-bot
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: sagemaker-python-sdk-local-mode-tests
  • Commit ID: d5c3779
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@larroy
Copy link
Contributor Author

larroy commented Oct 15, 2021

@navinsoni @shreyapandit gentle ping

@sagemaker-bot
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: sagemaker-python-sdk-unit-tests
  • Commit ID: 569f495
  • Result: FAILED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@sagemaker-bot
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: sagemaker-python-sdk-slow-tests
  • Commit ID: 569f495
  • Result: FAILED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@sagemaker-bot
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: sagemaker-python-sdk-local-mode-tests
  • Commit ID: 569f495
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@sagemaker-bot
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: sagemaker-python-sdk-unit-tests
  • Commit ID: 33729b1
  • Result: FAILED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@mufaddal-rohawala
Copy link
Member

Thanks, this PR is in our PR list to merge.

@larroy Can you update the PR to fix the unit test failure

Also the following steps will help to add a githook to reproduce and fix the unit tests locally

@shreyapandit shreyapandit marked this pull request as draft January 13, 2022 23:47
@larroy larroy force-pushed the wait_for_endpoint branch from 33729b1 to 3ec8007 Compare January 14, 2022 19:10
@sagemaker-bot
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: sagemaker-python-sdk-unit-tests
  • Commit ID: 3ec8007
  • Result: FAILED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@sagemaker-bot
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: sagemaker-python-sdk-local-mode-tests
  • Commit ID: 3ec8007
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@sagemaker-bot
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: sagemaker-python-sdk-slow-tests
  • Commit ID: 3ec8007
  • Result: FAILED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@sagemaker-bot
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: sagemaker-python-sdk-notebook-tests
  • Commit ID: 3ec8007
  • Result: FAILED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

ahsan-z-khan
ahsan-z-khan suggested changes Jan 19, 2022
View reviewed changes
Copy link
Member

@ahsan-z-khan ahsan-z-khan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is Is this being actively worked on?
If yes, can you resolve the conflicts and rebase with dev branch?
If not, we can close this.

@larroy
Copy link
Contributor Author

larroy commented Jan 27, 2022

I rebased, I will do again.

larroy and others added 2 commits February 11, 2022 19:02
@larroy
Add timeout to wait_for_endpoint and _wait_until.
b941b9f 
This is useful for cases in which and endpoint takes unusually long to
come online.
@shreyapandit @larroy
Add summary to waiter method
3a3a3d5
@codecov-commenter
Copy link

Codecov Report

Merging #2684 (3ec8007) into master (2ebba8a) will decrease coverage by 0.60%.
The diff coverage is 91.75%.

❗ Current head 3ec8007 differs from pull request most recent head 3a3a3d5. Consider uploading reports for the commit 3a3a3d5 to get more accurate results

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #2684      +/-   ##
==========================================
- Coverage   89.49%   88.88%   -0.61%     
==========================================
  Files         195      176      -19     
  Lines       16567    15579     -988     
==========================================
- Hits        14826    13847     -979     
+ Misses       1741     1732       -9
Impacted Files Coverage Δ
src/sagemaker/image_uris.py 99.32% <ø> (+0.52%) ⬆️
src/sagemaker/tensorflow/model.py 89.13% <ø> (-1.09%) ⬇️
src/sagemaker/workflow/execution_variables.py 100.00% <ø> (ø)
src/sagemaker/session.py 70.45% <73.68%> (-0.13%) ⬇️
src/sagemaker/tuner.py 97.91% <83.33%> (ø)
src/sagemaker/lineage/context.py 77.77% <88.23%> (-4.21%) ⬇️
src/sagemaker/estimator.py 91.18% <100.00%> (-0.15%) ⬇️
src/sagemaker/lineage/query.py 95.13% <100.00%> (+0.17%) ⬆️
src/sagemaker/model.py 89.05% <100.00%> (-2.36%) ⬇️
src/sagemaker/parameter.py 97.43% <100.00%> (ø)
... and 54 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2ebba8a...3a3a3d5. Read the comment docs.

@sagemaker-bot
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: sagemaker-python-sdk-unit-tests
  • Commit ID: 3a3a3d5
  • Result: FAILED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@sagemaker-bot
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: sagemaker-python-sdk-local-mode-tests
  • Commit ID: 3a3a3d5
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@sagemaker-bot
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: sagemaker-python-sdk-slow-tests
  • Commit ID: 3a3a3d5
  • Result: FAILED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@vikas0203 vikas0203 requested review from a team, vikas0203 and mufaddal-rohawala and removed request for a team November 23, 2022 21:38
@vikas0203 vikas0203 self-assigned this Nov 23, 2022
@vikas0203 vikas0203 requested a review from a team November 23, 2022 21:38
@vikas0203 vikas0203 self-requested a review November 30, 2022 03:26
@sagemaker-bot
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: sagemaker-python-sdk-unit-tests
  • Commit ID: f733a35
  • Result: FAILED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@sagemaker-bot
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: sagemaker-python-sdk-local-mode-tests
  • Commit ID: f733a35
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@sagemaker-bot
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: sagemaker-python-sdk-pr
  • Commit ID: f733a35
  • Result: FAILED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@sagemaker-bot
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: sagemaker-python-sdk-slow-tests
  • Commit ID: f733a35
  • Result: FAILED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@sagemaker-bot
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: sagemaker-python-sdk-notebook-tests
  • Commit ID: f733a35
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@knikure knikure removed the request for review from vikas0203 May 2, 2023 21:49
@mufaddal-rohawala
Copy link
Member

Closing as this has been in draft state for too long! Please reopen if the change is still relevant.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@shreyapandit shreyapandit shreyapandit requested changes

@ahsan-z-khan ahsan-z-khan ahsan-z-khan requested changes

@vikas0203 vikas0203 vikas0203 approved these changes

@mufaddal-rohawala mufaddal-rohawala Awaiting requested review from mufaddal-rohawala mufaddal-rohawala is a code owner automatically assigned from aws/sagemaker-ml-frameworks

Assignees

@mufaddal-rohawala mufaddal-rohawala

Labels
needs contributor changes
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@larroy @sagemaker-bot @mufaddal-rohawala @codecov-commenter @shreyapandit @ahsan-z-khan @vikas0203